home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / renegade / rgep261.zip / FIN.EXE / FILEIN51.EXE / FILEIN!.DOC < prev    next >
Text File  |  1994-05-15  |  17KB  |  324 lines

  1.        FileIN! 5.1 Copyright 1994 by Chris Roberts and Patrick Spence
  2.                             All Rights Reserved.
  3.  
  4.  
  5. General Notes
  6. ─────────────
  7.     FileIN! is the answer to file importing problems with Renegade. This
  8.     utility will correctly import a TICK FILES.BBS to the appropriate *.DIR
  9.     file(RG directory). This extremely quick utility has many features that
  10.     make it the ideal addition to any Renegade system.
  11.  
  12.     It will check for dupes and make sure that the file to be imported does
  13.     reside in the currently directory. It will update extended descriptions
  14.     over 45 characters with a word wrap. BIOS writes can be forced over the
  15.     default direct video ram writes for certain multi-tasking environments.
  16.     It can optionally NOT purge the FILES.BBS file, if you wish to have
  17.     more than one BBS system use the same file directories, this option is
  18.     for you, as certain BBS systems read the FILES.BBS for the file
  19.     description info. It can also be used on a CD-ROM to import
  20.     descriptions.
  21.  
  22.     For users of Allfix, you do not need to have the description shoved all
  23.     on one line any longer. FileIN! will read the multi-line FILES.BBS, and
  24.     import up to 5 lines into the Renegade dir. 10 line importing will be
  25.     added as soon as Renegade supports it.
  26.  
  27.     FileIN! is intended for use by EXPERIENCED Renegade sysops. It is
  28.     possible to destroy data(incoming TIC files) now with improper setup of the
  29.     archive configuration. If you don't know what your doing, ask someone who
  30.     does. Patrick and I may be able to help, the number to Patrick's system
  31.     is at the end of this document.
  32.  
  33. Usage
  34. ─────
  35.  
  36. Usage is very straight-forward as follows:
  37.  
  38. FILEIN <path to FILEIN.CFG> <-I>
  39.  
  40. A -I in the commandline invokes IGNORE mode. More on this later.
  41.  
  42. Configuration
  43. ─────────────
  44.  
  45. Run FILECFG.EXE, and it will create a setup file in the current directory,
  46. filename is FILEIN.CFG. You can put this CFG file anywhere, however you are
  47. required to load filein from your main renegade directory.(ie, c:\renegade)
  48.  
  49. Hit P for path setup. There are two paths to enter, a swap path(when running 
  50. FIN.BAT) and a path for the main renegade directory. Pretty simple so far eh?
  51.  
  52. Option T is the toggle setup menu. The rest are pretty straightforward.
  53. The menu is as follows:
  54.  
  55. (A) Swap(run FIN.BAT) <-FIN.BAT is described below, toggle this to YES
  56.                         if you wish to use a FIN.BAT
  57. (B) Purge FILES.BBS   <-If you wish to keep your FILES.BBS, toggle this to
  58.                         No, if its yes FileIN! will not delete it after
  59.                         finishing the current base.
  60. (C) Use BIOS for Video<-Pretty self-explanatory. BIOS writes are SLOW however.
  61. (D) Scan CD-ROM bases <-Normally, this should be NO, as CD-ROM drives are
  62.                         typically slow. You can turn this on to import the
  63.                         FILES.BBS of a rom disk you purchased.
  64. (E) Keep a Log Files  <-The log file contains start+stop times, and general
  65.                         info on the file bases and the files imported to those
  66.                         bases. The log now follows a binkley-style format.
  67. (F) Convert Archives  <-Info below, toggle yes if you wish to have them
  68.                         converted.
  69. (G) Custom Scan list  <-When toggled to yes, you can select which bases you
  70.                         want FileIN! to scan, which means faster runs. See
  71.                         below for instructions on how to set this up.
  72. (H) Files Uploaded by <-This can be "Sysop", your real name, or whatever you
  73.                         like. When you list files in renegade, it can display
  74.                         who originally uploaded the file. This text is placed
  75.                         in that field.
  76. (I) Registered to     <-Your name as it appears on the card with your serial
  77.                         number(assuming you've registered)
  78. (J) Serial Number     <-Your serial number(which you receive when you
  79.                         register.)
  80.  
  81. Option A is the archive conversion setup. You CAN put the archivers in this
  82. menu, however FileIN! will not attempt to convert any archives unless you
  83. have a valid serial number(which you get by registering).
  84.  
  85. Working on Archive Entry #1
  86.  
  87. Remember: %F=Complete path+filename+extension
  88.           %W=Work Directory created at runtime
  89.           Success Errorlevel is generally zero.
  90.  
  91. (A) Extension ID:   <--This is the 3 char extension, ex: ZIP,ARJ,ZOO,SDN etc
  92. (B) Decompression Commandline: for Arj it would be 'ARJ E %F %W' or
  93.                                for an SDN it would be 'GUS %F %W'
  94.                                You MUST have GUS installed 'SDN' files.
  95.                                Do NOT insert a path here, the renegade
  96.                                archivers path is added automatically!!
  97. (C) Compression Commandline: again, for arj 'ARJ A %F %W'
  98.                              Do NOT insert a path here, the renegade
  99.                              archivers path is added automatically!!
  100. (D) Success Errorlevel: Zero for everything except PKPAK to my knowledge.
  101.                         For PAK/PKPAK set it to -1(ignore).
  102.  
  103. You can install up to ten archivers. Renegade has a maximum of eight, the
  104. extras are so you can convert the pointless *.SDN files that you receive in
  105. certain networks to a identifiable archive type(such as a ZIP or ARJ file).
  106. To setup the conversion of SDN's is very simple. You create an archive type
  107. with the extension ID of SDN, and the decompresssion commandline "GUS %F %W"
  108. You must have GUS(General Unpack Shell) to accomplish this. The compression
  109. commandline may be left blank, as it is usually unused for this type. You
  110. SHOULD use the /N(ignore imbedded directories) when using GUS, as if the
  111. archive is allowed to extract to a different directory, FileIN! will not
  112. find the files that were in the archive and the conversion will abort.
  113.  
  114. *** FileIN! converts archives to the type specified in the base setup inside
  115.     Renegade. If you (M)odify a file base inside renegade, it is option 8.
  116.     SDN's are converted by extracting with GUS as shown above, and then the
  117.     files are re-archived using the type you specified in your file base.
  118.  
  119. *** FileIN! does not change to the temp directory when creating an archive.
  120.     What this means is, your archive could end up with a directory structure
  121.     of 'D:\REN\FILE\ITCSDN\!FILEIN!.TMP\SAMPLE.XXX' on each file. To disable
  122.     this, add the appropriate option to the compression commandline. This is
  123.     one of those "Read the Docs" type things. For ARJ tho, put a -e in the
  124.     commandline.
  125.  
  126. FileIN! will convert an archive BEFORE it runs FIN.BAT, that is so you can
  127. convert the archives to whatever format you like, then extract the .DIZ and
  128. .SDI comment files(if any) from the archive, scan it, and add your bbs
  129. advertisement/comment to the archive.
  130.  
  131. FileIN! will NOT attempt to convert archive types on CD-ROM flagged bases.
  132. To futher that point, if you try to convert archives that are on a CD-ROM,
  133. unpredictable results could occur. I have done my best to check for things
  134. like this, but without a CD-ROM I can't be sure. I would highly suggest
  135. you NOT try it.
  136.  
  137. To go a bit further on CD-ROMs. If you have a CD-ROM that you are importing
  138. for the first time, you need to toggle "Scan CD-ROM bases" in Filecfg to YES.
  139. You will need to make a custom FIN.BAT that will extract the comment files
  140. to the UPLOAD path of the cd-rom base on your harddrive, not the current
  141. directory as you would normally do. If a file base is set with the CD-ROM
  142. flag, after running FIN.BAT it will search there for comment files. CD-ROM
  143. bases are passed a third paramater. %3 is the upload path for the current file
  144. base with a trailing '\', use that to extract comment files. %3 is ONLY
  145. passed when you are scanning a CD-ROM base.
  146.  
  147. When using a FIN.BAT or archive conversion, you should have the commandline
  148. that runs the archiver instuct it to assume YES on all queries. This is to
  149. prevent something like "File XXXX.XXX exists, overwrite?" from happening
  150. when FileIN! is spawned out, which would most likely hang your system all
  151. day.
  152.  
  153. FileIN! fully supports 4dos's memory(.BTM) batch files, just rename your
  154. FIN.BAT to FIN.BTM and make any necessary changes(4dos has many batch file
  155. enhancements).
  156.  
  157. Option M is the message posting setup. The menu is as follows:
  158.  
  159. (A)Message Posted by   : <-Typically sysop's name or "The Anonymous Announcer"
  160.                            etc.
  161. (B)Message Posted to   : <-All, My Users, etc etc
  162. (C)Message Subject     : <-"Newly Imported Files" or whatever.
  163. (D)Message Base Name   : <-This is the name of the .HDR and .DAT files of the
  164.                            message base you wish to have the messages posted
  165.                            in. The filename can be found by (M)odifying a 
  166.                            base in the renegade message base editor.
  167.                            Do NOT include the extension(HDR/DAT)
  168. (E)Path to PIN.EXE     : Do NOT put the PIN.EXE name on the end, trailing '\'
  169.                          is optional. Ex "D:\RG\UTILS\RGE"
  170. (F)Posting Active      : <-Toggle to YES to enable posting.
  171.  
  172. The message itself is slightly configurable on this release. The two text 
  173. files, HEADER.TXT, and FOOTER.TXT, go in the \MISC or \AFILES directory
  174. (if you dont know what this is, its in your renegade system config). You may
  175. edit these messages as you like, both support only TWO mci codes, time(%TI)
  176. and date(%DA). HEADER.TXT is imported before FileIN! begins scanning bases,
  177. FOOTER.TXT is imported just before the final tear line.
  178.  
  179. Option B is the custom scan list toggling. When you type E, you will be
  180. presented with a screenful of file bases with a scrollbar that lets you
  181. flip thru the list. HOME,END,PGUP,PGDN, and the arrows let you move around.
  182. Hit space on each base you wish to have scanned, and a box marker will appear 
  183. next to its name. Turn on only the bases you need scanned (ie, your SDN 
  184. bases, cdrom bases etc) and then turn option G(custom scan list)
  185. on the misc options/toggles menu to yes. At this point, FileIN! will scan only
  186. the bases that you marked in this list, which means FileIN! will run faster
  187. in most cases.
  188.  
  189.  
  190. FIN.BAT
  191. ───────
  192.     
  193.     Well, major addition to the flexibility of FileIN!. You can now scan
  194.     inbound SDN files for virii, insert BBS comments, and import the
  195.     FILE_ID.DIZ or DESC.SDI inside an archive if it exists.
  196.  
  197.     Setting it all up is quite simple. You make a batch file, filename is
  198.     FIN.BAT, and use that to perform all desired operations. Two parameters
  199.     are passed to FIN.BAT, %1 is the complete path+filename and extension.
  200.     %2 is the extension only. %1 is used for the DIZ file extraction, you
  201.     can do something like this in the batch file.
  202.  
  203. if %2=ZIP then pkunzip %1 FILE_ID.DIZ DESC.SDI
  204. if %2=ARJ then ARJ e %1 FILE_ID.DIZ DESC.SDI
  205.  
  206.     etc etc. You can add as many archivers as you want.
  207.  
  208.     You may also run SCAN, TBAV or THDPRO on the archive, and if it contains a
  209.     virus, you may delete it by simply doing a DEL %1. After FIN.BAT has
  210.     finished, if the file no longer exists it is skipped and operation continues
  211.     as normal. Two sample batch files are included, one requires THDPRO to be
  212.     installed on your system. If you DON'T have THDPRO, consider installing it,
  213.     it's an excellent package!  Remember that even though the sample batch
  214.     files are named SAMPLE1.BAT and SAMPLE2.BAT, you will STILL need to
  215.     name your batch file FIN.BAT (or FIN.BTM for 4dos or nDos users).
  216.  
  217. Restriction on FIN.BAT
  218. ──────────────────────
  219.     When extracting .DIZ or DESC.SDI files, they MUST be extracted to the
  220.     current directory. You can use the lines above in your batch file, or,
  221.     if you have GUS you can do this
  222.  
  223.     GUS %1 FILE_ID.DIZ DESC.SDI
  224.  
  225.     As far as scanning is concerned...if you delete the file(del %1) when
  226.     filein returns from running the batch file, it will skip the entry if
  227.     the file no longer exists.
  228.  
  229.     FIN.BAT or FIN.BTM(4dos batch) must exist either in the current
  230.     directory or in a directory in your PATH statement. Swapping to run
  231.     FIN.BAT is disabled if toggle 'Run FIN.BAT' is no in the options menu, or
  232.     the swap path you specified cannot be located.
  233.  
  234.     You need to give filein as much ram as possible. Certain compressors,
  235.     like ARJ, require large amounts of ram for initialization. If you
  236.     decide to run THDPRO in your batch file, you'll need even more. FileIN!
  237.     does swap, however I'd say 200k at the absolute minimum, more(around
  238.     420+) would be ideal. The swap routines have been known to blow up if
  239.     they run out of ram, so if filein locks, try to free up more memory.
  240.  
  241.     Minor Glitch fixes, etc etc. Overall, its much more stable than before.
  242.  
  243.  
  244. Special Precautions
  245. ───────────────────
  246.     FileIN! is now fully multi-node capable. I have been able to run it under
  247.     DesqView/X with 3 windows open, two running renegade, with no problems.
  248.     However, you should still make freqent backups of crucial data
  249.     (the \DATA or \GFILES directory is of utmost importance). 
  250.  
  251. Bugs + Suggestions
  252. ──────────────────
  253.     I have tested FileIN! to the best of my ability, however with my
  254.     fairly rushed schedule I'm not going to promise that its perfect. I
  255.     haven't had any problems reported by the testing sites, but if you do
  256.     come across a problem, document it including if applicable the runtime
  257.     error number, and the address, ex 0000:FFE7.
  258.  
  259.     Runtime errors are now trapped in a file called FILEIN.ERR. If you have
  260.     a runtime error, send this file to Patrick, his BBS #/network addresses
  261.     are at the bottom of this document.
  262.  
  263.     I owe a LOT to many people for testing, particularly Patrick
  264.     Spence(gave me the idea for FIN.BAT), Steve Zapatka(loyal tester), Dan
  265.     Jones, Joe Farrell, Richard Rector, Frank Ward, Fred Cohen, and
  266.     countless others who have expressed interest and have helped test the
  267.     beta versions. Thanks to all.
  268.  
  269.  
  270. Legal Stuff
  271. ───────────
  272.     FileIN! is *FREE*. Yes, something for nothing, like all my utils. I am
  273.     not under ANY circumstances responsible for damage to ANYTHING that
  274.     results from the use or misuse of FILEIN.EXE. Please read REGISTER.DOC,
  275.     but your only investment will be a postcard. You NEED to send that
  276.     postcard if you plan on using the new features, as this version of
  277.     FileIN! will only run fully with a valid serial number.
  278.  
  279.     FileIN! is Copyrighted material by Chris Roberts and Patrick Spence,
  280.     you are given permission to reproduce and distribute the main ARCHIVE
  281.     (ZIP, ARJ, or whatever format it's in) as long as the original contents
  282.     are NOT altered in ANY way. You may NOT charge for the distribution of
  283.     this file other than a disk duplication/postage charge. You may NOT
  284.     add, remove, or modify files from the original archive created by Chris
  285.     Roberts. You may NOT place FileIN! in a collection of utilites being
  286.     sold for profit(example, placing FileIN! on a CD-ROM for sale to sysops)
  287.     without prior written consent by Chris Roberts or Patrick Spence. My
  288.     address is in UPDATE.DOC, contact me if necessary. Permission for this
  289.     type of distribution is not a hassle and can usually be faxed out to you
  290.     within a day of receipt of your request.
  291.  
  292.     Renegade is Copyrighted by Cott Lang. (Like you didn't know that) :-)
  293.  
  294.     This program uses a customized version of Ralf Brown's SPAWNO routines
  295.     to minimize memory use while running other programs or shelling to
  296.     DOS.
  297.  
  298.     Special thanks to Patrick Spence of Hawk's Aerie, Fred Cohen of
  299.     DemoSoft, and Steve Zapatka of Crazy BBS for testing the program and
  300.     reporting bugs.
  301.  
  302. Bug Reports
  303. ───────────
  304.     Bug reports should be sent to Patrick Spence.  Various methods of
  305.     contact are:
  306.         BBS:                Hawks Aerie! 1-602-873-2755
  307.         Front End Mailer:
  308.                             ITC Net @ 85:823/0
  309.                             Fido Net @ 1:114/252
  310.                             RG Support Net @ 50:220/4
  311.                             Candy Net @ 42:1002/5
  312.                             God Net @ 143:602/2873
  313.                             Strange Net @ 84:84/1
  314.         Echos:
  315.                             ITC Net RG support echo
  316.                             Fido Net RG Support echo
  317.                             RG Support Net (all echos)
  318.  
  319.     -OR- You can call my BBS at (602)545-9458
  320.          ITC (85:823/813), 28.8k arriving shortly.
  321.  
  322. And keep in mind, our netmail box is always open and waiting for suggestions
  323. and problem reports.
  324.